Getting Started

TL;DR

pip install waloviz
apt-get install ffmpeg

import waloviz as wv
wv.extension()

wv.Audio('https://www2.cs.uic.edu/~i101/SoundFiles/CantinaBand3.wav')

This web page was generated from a Jupyter notebook and not all interactivity will work on this website. Right click to download and run locally for full Python-backed interactivity.

Explanation

waloviz was built to be as accessible as possible, whether you’re using jupyter, colab, VSCode, JupyterLab or just pure HTML - you’ll only need three lines of code.

First we need to install waloviz: .. code-block:: shell

pip install waloviz

We also need to install ffmpeg as a backend for torchaudio: .. code-block:: shell

apt-get install ffmpeg

Then we need to import waloviz and activate the extension: .. tab:: jupyter

import waloviz as wv
wv.extension()

Then we need to call wv.Audio with our URL or file-path:

And… that’s it, you’re done. You can use the player to interact with your audio.

## Using the player The controls are pretty intuitive, but here are the most important controls you should to know: 1. A single click anywhere - toggles playpause. 2. Scrolling with the mouse wheel - zooms inout. 3. Dragging the mouse while pressing down - moves forwardsbackwards. 4. The small ↺ icon on the top left - resets to the initial view. 5. Clicking on the Download waloviz.html - will download an HTML version of the player.

To learn more, read our [User Guide](./user_guide.md).